/*
     This file is part of Advanced Strategic Command; http://www.asc-hq.org
     Copyright (C) 1994-2010  Martin Bickel 
 
     This program is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
     the Free Software Foundation; either version 2 of the License, or
     (at your option) any later version.
 
     This program is distributed in the hope that it will be useful,
     but WITHOUT ANY WARRANTY; without even the implied warranty of
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
     GNU General Public License for more details.
 
     You should have received a copy of the GNU General Public License
     along with this program; see the file COPYING. If not, write to the 
     Free Software Foundation, Inc., 59 Temple Place, Suite 330, 
     Boston, MA  02111-1307  USA
*/

#ifndef actionavailabilityH
#define actionavailabilityH

#include "../ascstring.h"

/**
*/
class ActionAvailability {
   public:
      enum Availability { notAtAll,  //!<  the action is not available and no action symbol shall be shown to the user. 
                          partially, //!<  the action would be available, if not some prerequisites are missing which the user could provide
                          available  //!<  the action can be executed right now 
                        };
                        
      ActionAvailability();
      ActionAvailability& set( Availability avail, const ASCString& msg );
      Availability getAvailability() const;
      ASCString getMessage() const;
      bool ready() const;
      virtual ~ActionAvailability() {};
   private:
      Availability avail;
      ASCString message;
};

#endif
